BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / doors_1 / afreq301.zip / AUTOFREQ.DOC < prev next >

Wrap

Text File | 1992-08-25 | 20KB | 378 lines

╔══════════╗ ║ ║ ║ AUTOFREQ ║ ║ ║ ╚══════════╝ AUTOFREQ- A utility to allow SLBBS sysops to allow their users to request files for FREQ, and to automatically request those files using your mailer software. Program Information =================== Program: AUTOFREQ Version: 3.0 Author: Russell Steinthal Archive: AFREQ30.* Installation ============ To install AutoFREQ: 1. Unarchive the distribution archive containing AutoFREQ into its own subdirectory. 2. Run AFSETUP.EXE. Explanation of that program follows. 3. Optionally, customize the message sent to users to notify them of the arrival of a requested file. A sample message is included in the archive as NOTIFY.TXT. 4. Add AutoFREQ to your doors menu. AutoFREQ makes all of its writes to the BIOS, and requires that they be redirected to the modem by the BBS software. AFSETUP ======= The first section of AFSETUP prompts you for some basic configuration information about your system. (Note: For all prompts in this section, specify COMPLETE paths to all files, or AutoFREQ may not function correctly.) 1. Batch file to write commands to: This is the path and filename of a batch file to which AutoFREQ will output commands to request files. These commands will be configured later on in the program. This batch file, when run, will actually request files from other nodes, if the commands are configured correctly. 2. AutoFREQ log file: This is the path and filename to a text file in which AutoFREQ will log all requests. This file will be created and expanded dynamically by AutoFREQ, and should not have the same path and filename as an existing file, as any existing file of this name will be overwritten by AutoFREQ. 3. Path and filename to write filenames and descriptions to: This is a file to which AutoFREQ will write the filenames and descriptions of the files that are requested and received. It is the sysop's responsibility to call a file importer(such as F2DIRM by Wayne Robinson, which is included with AutoFREQ) with this file in order to import the received files into the file database. The same note about overwriting existing files applies as with the previous prompt. 4. Path to move received files TO: This is the path where you want AutoFREQ to move files which have been requested and which have arrived to. (Note: The final \ on the path must be present in order for AutoFREQ to function correctly.) 5. Path to move received files FROM: This is the path where your mailer software will place files that it has requested and which have arrived. AutoFREQ moves files from this path to the path specified in the previous selection. (Note: The final \ on the path must be present for AutoFREQ to function correctly.) 6. Your BBS name: This is very easy, limit 100 characters. 7. Security level necessary to access sysop functions: There are several functions available in AutoFREQ for sysops. This is where you specify the security level that a user needs to be able to access these functions. It is recommended that you set this selection to the level of the sysop account on your system, and possibly the level of the co-sysop(s). WARNING: Setting this level to the level of a normal user will seriously compromise the security functions of AutoFREQ! The second portion of AFSETUP is where you specify information about the nodes that you want users to be able to request from. One of the primary security features of AutoFREQ is the fact that users can only request from nodes which you have specified, and provided the file list for. You must supply the master file list for all nodes that you want the user's to have access to. (The exception to this is the Blind Request function in the Sysop Options menu.) AFSETUP prompts you for the following information: 1. Name of node: This is easy- the name of the node you are specifying. 2. Node number: This is the network node number of this node. This must be accurate for AutoFREQ to function. 3. Master file list: This is the path and filename of the file which contains the master list of files available on the node. 4. Minimum security level to access this node: This is the security level a user needs to access this node. After this, AFSETUP asks if you want to enter another node. If you answer yes, it repeats the procedure from step 1 above. If your answer is no, it continues to the next stage of the installation. In the next portion of the installation procedure, AFSETUP prompts you for information on the request limits you want to specify. Simply specify each security level that users possess, and specify that level's maximum files and bytes to allow. Enter 0 for maximum bytes or files to indicate no limit on that field. For more information, see the section "Request Limits" later in this documentaion. The next section involves the actual commands used by AutoFREQ in requesting files. You are asked to input the command format for requesting files. If you are using XRobot or a similar utility, you should specify the syntax for calling that utility here. If the syntax requires the name of the file, specify <F>, and if it requires the node number to request from, specify <N>. Following this, AFSETUP asks you for the commands which precede all requests in the batch file. These commands should execute whatever directory changes, etc. that need to be performed prior to requesting files. Enter a blank line to end input. The final option that needs to be set is the prefix commands for the notification batch file. These commands are executed before mail notification is sent to users, and should change to the directory containing the message files, etc. Follow the same instructions as the previous choice for entering this information. Command Syntax for calling AutoFREQ =================================== AUTOFREQ <user's first name> <user's last name> <sec. level> or to enter maintanance mode, AUTOFREQ /MAINT Operation of AutoFREQ ===================== This section details how to use AutoFREQ in its user, or non-maintanance mode. When the program starts, it displays a menu of nodes available. The user selects a node from the list to request from by specifying the number that appears next to the name of the node. From here, AutoFREQ moves to the main menu. Main Menu ========= The main menu has 4 options, with a 5th present if the user has sysop access. The options are explained below: [L]ist files available ---------------------- This presents the user with a list of all files available on this node. It takes this information from the master file list you provided for this node. After each screen of information, the output pauses, and prompts the user to ask if he or she wants more. Answering N returns the user to the main menu, and any other key gives the user the next screenful of files. [R]equest file -------------- This prompts the user for the name of the file to request. The filename the user inputs must exactly match one of the filenames in the master file list for the node that the user is requesting from. If the file is not on the master file list, AutoFREQ responds, "File <filename> was not found." and returns to the main menu. If the file is found, AutoFREQ checks to see if the file has already been requested. If it has, AutoFREQ outputs a message and asks the user if he or she wants to be notified when the file arrives. For more information on this, see the section "Mail Notification" later in this file. If the file has not already been requested, AutoFREQ checks whether requesting this file would put the user over his/her security level's request limits. (See "Request Limits" later in this file) After all of these checks, AutoFREQ outputs a message saying the file has been requested, and waits for the user to press a key. After this, the user is returned to the main menu. [S]elect node to request from ----------------------------- This option allows the user to change the node to request from. This returns the user to the menu of nodes that was displayed when AutoFREQ was started. [E]xit AutoFREQ --------------- This doesn't need much explanation... [A]ccess sysop functions ------------------------ This option is present only when the user has sysop access, as specified in AUTOFREQ.CFG. Selecting this option brings up a sub-menu containing the following options: [V]iew a user's record: This allows the sysop to view any user's total files and bytes requested, as well as the number of files and bytes requested since request limits were last reset. At the name prompt, entering "QUIT" returns the user to the previous menu, and "?" brings up a list of users. After a user's record has been displayed, pressing [R] resets that user's request limits. Any other key returns you to the name prompt. [N]ode Maintenance: This option brings up another sub-menu containing the following options: 1. [V]iew/edit node information: This displays a list of the nodes available, and prompts for a number. The information for that node is then displayed. The sysop can change any of this information by choosing an option from the menu on the screen. Selecting "5" saves the changes and returns the user to the sysop options menu. 2. [A]dd a new node: This allows the sysop to add one or more new nodes. The procedure is the same as the procedure for specifying node information in AFSETUP. 3. [D]elete a node: This displays a menu of available nodes, similar to the menu displayed by the [V]iew/edit node command. The user selects a node, and after confirmation, AutoFREQ deletes that node from the list of available nodes. 4. [E]xit to the previous menu: Returns the user to the sysop options menu. [R]equest a file from a node: This command allows the user to specify a "blind" request, a request from ANY node, not necessarily one of the nodes that are setup in AutoFREQ. The user is prompted first for the node, and then for the filename to request. Pressing enter at either prompt aborts the process. After the node and filename have been entered, AutoFREQ prompts for confirmation. If the selections are confirmed, AutoFREQ requests that file. [E]xit to the previous menu: Exits to the previous menu. Magic Filenames =============== On some systems, files are made available for FREQ using "magic filenames". These are filenames which can be requested which are not the actual DOS filenames of the files they represent. AutoFREQ only partially supports magic filenames. If the sysop using the blind request feature requests a magic filename, AutoFREQ will correctly handle that request. However, AutoFREQ has no way of knowing its actual filename, and when the file arrives, AutoFREQ will not know it has arrived. This means that AUTOFREQ /MAINT will not perform its usual actions on that file. The command that requested the file will not be removed from the batch file, and if the file had been requested using the normal main menu [R]equest function, the file's description will not be imported into the BBS file directory. The fact that the command is not removed from the batch file results in that file being continually requested if the command is not removed manually. This problem will not occur if the system is set to delete the command batch file during its daily maintenance. (The sample batch file provided later on in this file implements the daily deletion of the batch file.) Request Limits ============== One of the ways in which AutoFREQ provides security is in the request limits function. This allows sysops to limit the number of files and bytes a user can request. The information is kept in the file LIMITS.LST. The format of this file is: <security level> <max files> <max bytes>. A maximum of 0 indicates no limit. If a user possesses a security level which is not present in LIMITS.LST, AutoFREQ imposes no limits on that user. When a user has reached the limit in bytes or files, AutoFREQ does not allow that user to request any more files. The user is not able to request additional files until his/her limit is reset. There are 2 ways of doing this: 1. A sysop can reset an individual user's limits by viewing the user's record, and then pressing "R". 2. To reset all users' limits, the sysop needs only to delete the file LIMITS.USR from the AutoFREQ directory. This file will be recreated by AutoFREQ the next time a user requests a file. The second method of resetting limits can be used by the sysop to set daily, weekly, monthly, etc. limits. For example, to set weekly limits, the sysop needs to configure an event to run every seven days, and have that event delete LIMITS.USR. To set daily limits, simply delete LIMITS.USR every day. Maintenance Mode ================ When invoked with the /MAINT command line switch, AutoFREQ enters the maintenance mode. When in this mode, AutoFREQ does not display any user interface. Instead, it performs all of the necessary file importing and related operations. AutoFREQ checks its list of requested files, and if it finds any of the files on that list in the directory specified as the "move from" directory in AUTOFREQ.CFG, it moves those files to the "move to" directory. It then accesses the master file list for the node that provided the file, and extracts the description. It then writes the filename and description to the text file specified in AUTOFREQ.CFG. AutoFREQ then deletes the command that requested that file from the command batch file, and then it sends mail notification to all users who are on the notification list for that file. Finally, AutoFREQ processes all files which had been "blind" requested, and terminates. Under normal circumstances, AutoFREQ outputs to the screen only its copyright notice during this process. Mail Notification ================= When a file which has been requested arrives, AutoFREQ sends a message in the BBS mail system to the user(s) that requested the file to notify them that the file has arrived. The text of the message is configurable by the sysop, and is stored in the file NOTIFY.TXT. This file must be present in the same directory as AutoFREQ. To allow sysops to define messages, certain codes are active in the message text. When AutoFREQ reads the message text and finds one of those codes embedded in the text, it replaces the code with the correct string. The codes are as follows: <N> Node number requested from <NN> Node requested from's name <F> Filename requested <FN> User's first name <LN> User's last name <D> Description of the file To send the mail notification messages, AutoFREQ invokes the SLMAIL utility which comes with SLBBS. AutoFREQ invokes SLMAIL by means of a batch file, and the commands which are specified during the execution of AFSETUP are executed prior to executing SLMAIL. These commands are stored in the file NOTIFY.PRE. Batch Files =========== AutoFREQ, and for that matter most BBS software and utilities, requires batch files to operate properly. With a good set of batch files, AutoFREQ will seamlessly interface with mailer and BBS software to completly automate file requesting. The following is a sample batch file for use with AutoFREQ, FrontDoor, and SLBBS. The author of AutoFREQ makes no warantee concerning the effectiveness of this batch file, it is provided as a sample only. (Thank you to Jim Malkowski, sysop of The Final Frontier BBS- The official AutoFREQ Support BBS and distribution site! 201-387-9510, for the use of his batch file.) rem Change to the directory containing AutoFREQ cd\autofreq autofreq /maint rem Change to the directory to which AutoFREQ moved the files cd\slbbs\files\freqs rem Run F2DIRM, a file importer. f2dirm requests c:\utilitie\dirmaint.exe c:\slbbs\files.bbs /D /R cd\slbbs rem Delete the batch file that AutoFREQ wrote commands to. You do this if rem you don't want to request files the next day that didn't arrive the rem first day. del nitefreq.bat cd\slbbs Registration ============ AutoFREQ is shareware. You are free to use AutoFREQ for an evaluation period of 2 weeks. If, at the end of that time, you continue to use AutoFREQ, you are required to register the software. The registration fee for AutoFREQ is $5, and entitles the user to free upgrades and notification of all bugs (hopefully none) which are found in AutoFREQ. Registering also removes the unregistered message in the main menu screen, and the message and time delay on exit of the program. To register AutoFREQ follow the instructions in the file REGISTER.TXT. License ======= AutoFREQ is shareware. It is not free. You are free to use AutoFREQ for an evaluation period of two weeks. After that, if you continue to use AutoFREQ, you are required to register it. You may freely copy and distribute AutoFREQ, provided that you always distribute the ENTIRE archive. You may not charge any fee for AutoFREQ, except for a nominal charge to cover the cost of disks. If you are distributing AutoFREQ for any charge other than for postage, you must notify the author. Under no circumstances is the author's copyright to be removed from the program. Decompiling and other reverse engineering of AutoFREQ is prohibited. The registration key for AutoFREQ that users receive with registration is never to be distributed. At no point does the author lose his copyright on the software, and the author retains at all times the right to limit the distribution and use of AutoFREQ. Comments, Questions, etc. ========================= If you have any comments, questions, complaints, bug reports, or suggestions about AutoFREQ, please feel free to contact the author, who can be contacted at any of the following addresses: U.S. Mail: Russell Steinthal 366 Whitman Street Haworth, N.J. 07641 On the Final Frontier BBS: Fidonet: 1:2604/206 SL-Net: 250:104/1227 Phone: (201) 387-9510 (On the Final Frontier BBS the author can be mailed as RUSSELL STEINTHAL, and there is a message subboard setup for support of AutoFREQ) The Final Frontier BBS is the official support and distribution site for AutoFREQ. The latest version of AutoFREQ will always be available on the Final Frontier BBS. Contact Jim Malkowski of DCS<Data Communications Systems, on the Final Frontier BBS to order AutoFREQ On-Line, and also browse through our verbose product listings of which you may also buy ON-LINE, by this author and many others....Call Today! Copyrights ========== The following are copyrights of other authors, which were used in this file: F2DIRM is a utility by Wayne Robinson, sysop of the Quantum Zone, Fidonet 1:2604/0. SLMAIL is a utility which comes with Searchlight BBS software, and is copyrighted by Frank Larosa and Searchlight Software. SLBBS (Searchlight Bulletin Board System) is copyright Frank Larosa and Searchlight software. XROBOT is copyright Joaquim H. Homrighausen. FROntDOor is copyrighted by Advanced Engineering sarl, and Joaquim H. Homrighausen.